Create Abstractions package #3567

paulmedynski · 2025-08-14T17:18:39Z

Abandoned in favour of #3626 and #3628.

Overview

As part of the Azure split work, a new Abstractions package is being created that contains types shared between MDS and its future extensions (Azure will be the first). This PR creates that package (with no meaningful content) to setup the MDS dependency, and get testing and CI setup accordingly.

I'm also experimenting with simplified .slnx files and some project directory structure changes.

This supercedes the original draft PR #3471.

Issues

The first step towards #1108.

Testing

Unit tests for the sample class to prove that CI can run them successfully.
There are no MDS tests to prove out the new dependency yet. Those will naturally happen when the first real bit of Azure functionality is moved out into the new Azure extension package.

paulmedynski

Adding comentary for reviewers.

I will be renaming the Extensions package to Abstractions. That round of changes is next.

eng/pipelines/dotnet-sqlclient-ci-core.yml

tools/props/Versions.props

paulmedynski

Commentary for reviewers, and issues for myself to fix.

eng/pipelines/dotnet-sqlclient-ci-package-reference-pipeline.yml

src/Microsoft.Data.SqlClient.Extensions/Abstractions/README.md

src/Microsoft.Data.SqlClient/NuGet.config

src/Directory.Build.props

BUILDGUIDE.md

codecov · 2025-08-15T16:55:03Z

Codecov Report

❌ Patch coverage is 53.24675% with 180 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.96%. Comparing base (fd16c6d) to head (50c52c1).
⚠️ Report is 6 commits behind head on feat/azure-split.

Files with missing lines	Patch %	Lines
...nt/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs	23.93%	89 Missing ⚠️
.../netcore/src/Microsoft/Data/SqlClient/TdsParser.cs	29.52%	74 Missing ⚠️
...lClient/src/Microsoft/Data/SqlClient/SqlCommand.cs	90.06%	15 Missing ⚠️
...ient/src/Microsoft/Data/SqlClient/SqlStatistics.cs	77.77%	2 Missing ⚠️

Additional details and impacted files

@@                 Coverage Diff                  @@
##           feat/azure-split    #3567      +/-   ##
====================================================
- Coverage             70.67%   69.96%   -0.71%     
====================================================
  Files                   277      276       -1     
  Lines                 61686    61641      -45     
====================================================
- Hits                  43598    43130     -468     
- Misses                18088    18511     +423

Flag	Coverage Δ
addons	`90.82% <ø> (ø)`
netcore	`73.75% <65.13%> (+0.39%)`	⬆️
netfx	`68.63% <61.31%> (-0.95%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Added empty Extensions package with some sample class and docs to demonstrate packaging. - Created CI stage to build, test, pack, and publish the Extensions NuGet package. - Updated downstream CI stages/jobs to use the Extensions package. - Updated build.proj Clean target to not delete packages/ dir. - Updated BUILDGUIDE with instructions for the Extensions package. - Cleaned up stale BUIDGUIDE sections. - Added temporary GitHub Discussion content so the team can review before posting it as a real Discussion. - Disable .pdb file inclusion in the application package. - Renamed Extensions package to Abstractions. - Updated README related to extensions design.

benrr101

I'm omitting all my comments about directory structure as per offline discussion. But I think we want to be really careful and thoughtful with how we set up pipelines, build targets, and project structure.

NuGet.config

build.proj

eng/pipelines/common/templates/jobs/ci-build-nugets-job.yml

eng/pipelines/stages/build-abstractions-package-ci-stage.yml

src/Microsoft.Data.SqlClient.Extensions/Abstractions/Abstractions.slnx

src/Microsoft.Data.SqlClient/NuGet.config

tools/props/Versions.props

- Addressed some of the review comments.

- Fixed missing Abstractions package version.

…iming (#3609)

* Task 38530: Prepare release notes - Added 7.0.0 Preview 1 release notes. * Task 38530: Prepare release notes - Addressed review comments. * Task 38530: Prepare release notes - Filled in actual build number.

benrr101

Awaiting the rest of the changes, but we're definitely making progress

eng/pipelines/stages/build-abstractions-package-ci-stage.yml

eng/pipelines/dotnet-sqlclient-ci-core.yml

build.proj

* netcore, netfx: sync declarations of TdsOperationStatus variables * netcore: reorder TryProcessUDTMetadata * netfx: reorder WriteTceFeatureRequest * netfx: reorder WriteAzureSQLSupportFeatureRequest * netcore, netfx: merge WriteInt and SerializeInt netcore: removed a simple WriteInt which did nothing besides call BinaryPrimitives. netcore: when there's space in the packet buffer, WriteInt will now write to it directly (rather than write to a stack-allocated span and copy.) * netcore: remove ConstructGuid method * netcore, netfx: refactor and sync serialization of guids * netcore, netfx: refactor and sync serialization of floats and doubles This removes the need for TdsParser.netcore.cs. * netfx: adjust TraceString - parameter was being passed to it which was never referenced in the format string * netcore: sync exception messages with netfx Messages of the netfx exceptions are more detailed * netfx, netcore: centralise masking of received server options Added mask to netcore logic. Also removed mask on _encryptionOption from netfx - this will never be outside the range of EncryptionOptions.OPTIONS_MASK. * netcore: enforce server certificate validation if AccessTokenCallback is set and certificate is not automatically trusted * netfx: add static lambda to TdsExecuteSQLBatch * netfx: remove failed attempt at static lambda This passed state around, but never passed enough state to remove the state machine. Sync with netcore. * netfx: sync reference to length of JSON metadata substitution sequence * netfx: pre-PR correction: match previous behaviour when writing Guid instances from WriteUnterminatedSqlValue * Flip order of debug assertion * Next round of code review Remove unnecessary conditional compilation. Add XML documentation to clarify SerializeShort, WriteShort et al. * netcore, netfx: sync TraceString Both platforms will now show the TransparentNetworkIPResolution status. This is always disabled on netcore. * Expand ParametersTest to include SqlGuid (including null value) * netfx: port RequestContinue call from netcore

) Co-authored-by: Shreya Rao <[email protected]>

- Changed MDS to reference Abstractions via project or package depending on build parameters. - Removed obsolete package reference files. - Updated CI pipelines to build Abstractions in parallel for Project-based builds.

- Modularized Abstractions CI templates.

- Cleaned up the project vs package pathways.

* Merge: * _parameters * _pendingCancel * _preparedConnectionCloseCount * _preparedConnectionReconnectCount * _prepareHandle * s_cachedInvalidPrepareHandle * Statistics * Merge Connection, DbConnection * Merging RetryLogicProvider and _retryLogicProvider # Conflicts: # src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlCommand.cs * Merge Transaction, DbTransaction * Merge CommandText * Replace "" with string.Empty * Merge CommandTimeout, _commandTimeout, and ADP.InvalidCommandTimeout * Merge CommandType * Removed temp storage of _commandType * Merge ColumnEncryptionSetting, _columnEncryptionSetting * Merge Parameters and DbParameterCollection * Merging DesignTimeVisible, _designTimeVisible * Merging EnableOptimizedParameterBinding, UpdatedRowSource, _updatedRowSource * Merge StatementCompleted and _statementCompletedEventHandler * Merging Notification, NotificationAutoEnlist, _notification, _notificationAutoEnlist, _sqlDep * Merge DefaultCommandTimeout, InternalTdsConnection, IsColumnEncryptionEnabled, InternalRecordsAffected, _rowsAffected, PropertyChanging() * merge _transaction and _batchRPCMode * Restore ResetCommandTimeout that got accidentally obliterated in a previous commit * Fix logic issue in IsColumnEncryptionEnabled, reinstate TypeDescriptor.Refresh on netfx

- Replaced generic "NugetPackageVersion" with variables names specific to the package (i.e. MdsPackageVersion, AkvPackageVersion, etc). - Removed top-level Abstractions package version parameters in favour of a variable.

- Fixes to Abstractions version number construction. - Fixes for some build.proj targets.

- Fixes for Abstractions and AKV default versioning.

- Added missing CI variable $(abstractionsPackageVersion)

- Fixed missing parameter when packing Abstractions.

* Expand code coverage for UDT serialization * Address test failures on 32-bit OSes * Make Microsoft.SqlServer.Server a PackageReference * Reformat SerializedTypes.cs * Switch to implicit object creation Also enforce this via editorconfig * Add and correct comments Also mandating this by generating a documentation XML file * Enable nullable for project * Declare and assign variables together * Moved MemoryStream to an instance variable * Post-merge build corrections * Reapply IDE0090 recommendations, disable CS1591 on newly-added tests * Next code review (first response) * Switch to using TheoryData * Nit: => movement * Rename tests * Split delegate for Assert.Throws into separate arrange/act/assert segment of each method * Disable CS1591 on new tests * Disable mandatory XML documentation * Change formatting of test data * Remove trailing XML documentation override

- Removed obsolete ADO Library inclusion in CI variables. - Moved MDS CI versions numbers into CI variables. - Fixed Abstractions versioning to handle CI version format.

paulmedynski

Adding commentary for reviewers, and some items for me to address.

eng/pipelines/common/templates/jobs/ci-build-nugets-job.yml

paulmedynski · 2025-09-18T21:27:01Z

eng/pipelines/common/templates/jobs/build-signed-package-job.yml

  variables:
  - template: ../../../libraries/variables.yml@self
  - ${{ if parameters.isPreview }}:
-    - name: NugetPackageVersion


I found NugetPackageVersion confusing - which nuget package? So I gave them names specific to the package. I didn't rename any of these yml files to match such changes though. I figure that's more trouble than it's worth, and we intend to re-factor the whole works here soon anyway.

Makes sense to me. I appreciate that kind of verbosity, and it was something I aimed to resolve in the AKV provider pipeline. Needs to be spread to other pipelines :D

eng/pipelines/common/templates/jobs/ci-run-tests-job.yml

paulmedynski · 2025-09-18T21:32:35Z

eng/pipelines/common/templates/steps/update-nuget-config-local-feed-step.yml

      Get-Content -Path "NuGet.config"
    displayName: 'Read NuGet.config [debug]'
-
- task: DotNetCoreCLI@2


Not sure why this was here, so I removed it.

paulmedynski · 2025-09-18T21:33:03Z

eng/pipelines/common/templates/steps/update-nuget-config-local-feed-step.yml

-    arguments: 'build.proj -t:restore'
-    feedsToUse: 'select'
-
- powershell: |


AKV .csproj already has conditional references depending on Project vs Package, so this wasn't necessary.

eng/pipelines/dotnet-sqlclient-ci-core.yml

paulmedynski · 2025-09-18T21:42:22Z

eng/pipelines/dotnet-sqlclient-ci-core.yml

            parameters:
              SNIVersion: ${{parameters.SNIVersion}}
              SNIValidationFeed: ${{parameters.SNIValidationFeed}}
-          - template: common/templates/steps/ci-prebuild-step.yml@self


This and the else block are identical, so I pulled them out.

src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj

tools/targets/add-ons/GenerateAKVProviderNugetPackage.targets

NuGet.config

- Addressed my own review comments.

- Fixed parameter typo in YAML.

benrr101

Yeah, I think this is a good improvement over the OG PR. We'll mess with it some more as we get time for it 👍

- Fixed Abstractions package versioning in official builds. - Fixed broken assembly version checks in official builds. - Removed Abstractions solution file.

- Fixing invalid package/assembly versions due to build numbers containing dots.

- Fixed official build assembly versioning.

- Fixed incorrect variable dereference syntax in expression.

- Fixed assembly versions > 65534.

- Improving diagnostics for assembly version checks.

- Trying to fix PowerShell variable expansion and assembly version checks.

- Diagnostics to figure out why MDS assembly file versions aren't being set.

- Added empty Extensions package with some sample class and docs to demonstrate packaging. - Created CI stage to build, test, pack, and publish the Extensions NuGet package. - Updated downstream CI stages/jobs to use the Extensions package. - Updated build.proj Clean target to not delete packages/ dir. - Updated BUILDGUIDE with instructions for the Extensions package. - Cleaned up stale BUIDGUIDE sections. - Added temporary GitHub Discussion content so the team can review before posting it as a real Discussion. - Disable .pdb file inclusion in the application package. - Renamed Extensions package to Abstractions. - Updated README related to extensions design. - Changed MDS to reference Abstractions via project or package depending on build parameters. - Removed obsolete package reference files. - Updated CI pipelines to build Abstractions in parallel for Project-based builds. - Modularized Abstractions CI templates. - Cleaned up the project vs package pathways. - Replaced generic "NugetPackageVersion" with variables names specific to the package (i.e. MdsPackageVersion, AkvPackageVersion, etc). - Removed top-level Abstractions package version parameters in favour of a variable. - Fixes to Abstractions version number construction. - Fixes for some build.proj targets.

…/SqlClient into dev/paul/azure-split/abstractions

- Fixed duplicate parameters from git merge.

paulmedynski · 2025-09-23T12:55:23Z

Abandoning in favour of #3626 and #3628.

paulmedynski added this to the 7.0-preview1 milestone Aug 14, 2025

paulmedynski force-pushed the dev/paul/azure-split/abstractions branch from e912975 to 261f4af Compare August 14, 2025 17:25

paulmedynski commented Aug 14, 2025

View reviewed changes

eng/pipelines/dotnet-sqlclient-ci-core.yml Show resolved Hide resolved

tools/props/Versions.props Show resolved Hide resolved

paulmedynski mentioned this pull request Aug 14, 2025

WIP | Create Extensions package #3471

Closed

cheenamalhotra reviewed Aug 14, 2025

View reviewed changes

tools/props/Versions.props Outdated Show resolved Hide resolved

paulmedynski commented Aug 15, 2025

View reviewed changes

paulmedynski marked this pull request as ready for review August 15, 2025 16:56

paulmedynski requested a review from a team as a code owner August 15, 2025 16:56

paulmedynski changed the title ~~[WIP] Create Abstractions package~~ Create Abstractions package Aug 15, 2025

paulmedynski assigned priyankatiwari08 Aug 26, 2025

apoorvdeshmukh self-assigned this Aug 27, 2025

paulmedynski force-pushed the dev/paul/azure-split/abstractions branch from c2a8e97 to d4464ec Compare August 29, 2025 12:06

paulmedynski force-pushed the dev/paul/azure-split/abstractions branch from d4464ec to f6bbbaf Compare September 5, 2025 14:27

paulmedynski modified the milestones: 7.0-preview1, 7.0-preview2 Sep 5, 2025

benrr101 requested changes Sep 9, 2025

View reviewed changes

paulmedynski and others added 5 commits September 15, 2025 09:44

Merge branch 'feat/azure-split' into dev/paul/azure-split/abstractions

a530c48

User Story 37654: Create Abstractions package

a9aaf95

- Addressed some of the review comments.

User Story 37654: Create Abstractions package

1fc50c9

- Fixed missing Abstractions package version.

Optimization: Use Environment.TickCount for SqlStatistics execution t…

1b1ddec

…iming (#3609)

[7.0.0-preview1] Prepare release notes (#3616)

780db73

* Task 38530: Prepare release notes - Added 7.0.0 Preview 1 release notes. * Task 38530: Prepare release notes - Addressed review comments. * Task 38530: Prepare release notes - Filled in actual build number.

benrr101 requested changes Sep 16, 2025

View reviewed changes

eng/pipelines/stages/build-abstractions-package-ci-stage.yml Outdated Show resolved Hide resolved

eng/pipelines/dotnet-sqlclient-ci-core.yml Show resolved Hide resolved

build.proj Outdated Show resolved Hide resolved

edwardneal and others added 6 commits September 16, 2025 17:39

Fix Debug Assertion in Connection Pool Due to Double Deactivation (#3587

6b0c5c2

) Co-authored-by: Shreya Rao <[email protected]>

User Story 37654: Create Abstractions package

5d136ea

- Changed MDS to reference Abstractions via project or package depending on build parameters. - Removed obsolete package reference files. - Updated CI pipelines to build Abstractions in parallel for Project-based builds.

User Story 37654: Create Abstractions package

beaf9c3

- Modularized Abstractions CI templates.

User Story 37654: Create Abstractions package

66cd309

- Cleaned up the project vs package pathways.

paulmedynski and others added 7 commits September 18, 2025 08:35

User Story 37654: Create Abstractions package

994cf81

- Replaced generic "NugetPackageVersion" with variables names specific to the package (i.e. MdsPackageVersion, AkvPackageVersion, etc). - Removed top-level Abstractions package version parameters in favour of a variable.

User Story 37654: Create Abstractions package

960a6c4

- Fixes to Abstractions version number construction. - Fixes for some build.proj targets.

User Story 37654: Create Abstractions package

dd39ffa

- Fixes for Abstractions and AKV default versioning.

User Story 37654: Create Abstractions package

11a5e70

- Added missing CI variable $(abstractionsPackageVersion)

User Story 37654: Create Abstractions package

865cfce

- Fixed missing parameter when packing Abstractions.

User Story 37654: Create Abstractions package

600803b

- Removed obsolete ADO Library inclusion in CI variables. - Moved MDS CI versions numbers into CI variables. - Fixed Abstractions versioning to handle CI version format.

paulmedynski commented Sep 18, 2025

View reviewed changes

paulmedynski added 2 commits September 19, 2025 08:55

User Story 37654: Create Abstractions package

327df5e

- Addressed my own review comments.

User Story 37654: Create Abstractions package

6dcb0db

- Fixed parameter typo in YAML.

benrr101 previously approved these changes Sep 19, 2025

View reviewed changes

User Story 37654: Create Abstractions package

88e95d5

- Fixed Abstractions package versioning in official builds. - Fixed broken assembly version checks in official builds. - Removed Abstractions solution file.

paulmedynski dismissed benrr101’s stale review via 88e95d5 September 19, 2025 20:30

paulmedynski added 10 commits September 20, 2025 12:23

User Story 37654: Create Abstractions package

5885cf8

- Fixing invalid package/assembly versions due to build numbers containing dots.

User Story 37654: Create Abstractions package

168755c

- Fixed official build assembly versioning.

User Story 37654: Create Abstractions package

a18bb4f

- Fixed incorrect variable dereference syntax in expression.

User Story 37654: Create Abstractions package

ddd0ee4

- Fixed assembly versions > 65534.

User Story 37654: Create Abstractions package

307430a

- Improving diagnostics for assembly version checks.

User Story 37654: Create Abstractions package

aa73678

- Trying to fix PowerShell variable expansion and assembly version checks.

User Story 37654: Create Abstractions package

5a35468

- Diagnostics to figure out why MDS assembly file versions aren't being set.

Merge branch 'dev/paul/azure-split/abstractions' of github.com:dotnet…

1b4ee9d

…/SqlClient into dev/paul/azure-split/abstractions

User Story 37654: Create Abstractions package

50c52c1

- Fixed duplicate parameters from git merge.

This was referenced Sep 23, 2025

Abstractions Package - C# project changes #3626

Merged

Abstractions Package - Pipeline Changes #3628

Open

paulmedynski closed this Sep 23, 2025

paulmedynski deleted the dev/paul/azure-split/abstractions branch September 25, 2025 16:21

Create Abstractions package #3567

Create Abstractions package #3567

Uh oh!

Conversation

paulmedynski commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Abandoned in favour of #3626 and #3628.

Overview

Issues

Testing

Uh oh!

paulmedynski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

paulmedynski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

benrr101 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benrr101 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

paulmedynski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paulmedynski Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

benrr101 Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paulmedynski Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

paulmedynski Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paulmedynski Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benrr101 left a comment

Choose a reason for hiding this comment

Uh oh!

paulmedynski commented Sep 23, 2025

Uh oh!

Uh oh!

paulmedynski commented Aug 14, 2025 •

edited

Loading

codecov bot commented Aug 15, 2025 •

edited

Loading